cboj-payments-prc-api

Description:

This API creates a standing order for funds to transfer internationally.

This API has the flexibility of following ACTIONs:

VALIDATE: A transfer request can be validated using VALIDATE action, which returns either a success / error response after validating the request. This is useful to correct the data if any before the actual fund transfer. Any VALIDATE action request will not update / process the backed Temenos system.

PROCESS: Once a request is validated / re-validated successfully using VALIDATE action, a request can then be sent for PROCESS action. This action actually transfers / schedules a transfer for the required fund / amount from the respective accounts.

AMEND: If any changes or modifications are required before processing the transfer , an AMEND action can be used for the same. AMEND action is similar to PROCESS action. The only difference is that the FT Reference ID (a unique transaction id received in response during PROCESS action), should be sent as a mandatory element, while other elements can be optional except for the modifiable field. This AMEND action works only until the record is Authorized. Once the record is Authorized, AMEND doesn't work.

DELETE: Any fund transfer request which is pending for authorization can be deleted using this action. FT reference number is mandatory for this action.

AUTHORIZE: Any fund transfer request which is pending for authorization can be authorized using this action. Unless a record is authorized , the actual fund transfer does not occur in the temenos core banking. Except for the FT reference number no other fields are required for authorization requests.

Mulesoft Request:

Headers:

Mandatory Headers: x-channel-id,x-client-trace-id, x-bank-id,client_id, client_secret

Optional Headers: x-sub-channel-id,x-user-id, Authorization, x-debug-flag, x-customer-id

Paramaters:

URI Params: NA

Query Params: NA

Content-type: application/json

Body:

{
  "ftRef": "4000218.2",
  "action": "PROCESS",
  "debitAccount": "4165253",
  "type": "FI",
  "payMethod": "OTAC",
  "currency": "JOD",
  "payAmount": "101",
  "creditAccount": "1000006",
  "currentFrequency": "20220531 e0Y e0M e0W e1D e0F",
  "currentEndDate": "20220601",
  "ftVersion": "FUNDS.TRANSFER?CBOJ.FCC.ACH.STO",
  "beneficiaryAccountNumber": "JO03EFBK0010000000000004143697",
  "chargesType": "SHA",
  "beneficiaryName": "TESTING1",
  "purposeCode": "0101",
  "beneficiaryAddress": "Beneficiary Address",
  "beneficiaryCountry": "JO",
  "remitanceInfo": "TESTING PAYMENT DETAIL REMIT INFO",
  "relation": "205",
  "recievingCountry": "GDI",
  "intermediateBank": "CBOJ",
  "acctountWithBank": [
    "HBHOJOAXXXX"
  ],
  "accountWithBankAccount": "",
  "sgBulkVal": "",
  "channelId": "",
  "channelRef": ""
}

Mulesoft Response:

Success Response: (200)

{
    "response": {
        "ftReference": "4165253.175"
    },
    "status": {
        "status": true,
        "code": 201,
        "arabicMsg": "تمت العملية بنجاح",
        "englishMsg": "The Operation has been Successfully Completed"
    }
}

Sample Error Response:

Please refer the HOME page for all possible combinations of error response codes.

Note: The 'errorCode' and 'backendErrorMessage' will be in the error response message only if 'x-debug-flag' is '1'

404 :

{
    "status": {
        "success": false,
        "code": "T24003799",
        "reasonCode": "",
        "arabicMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
        "englishMessage": "NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS",
        "errorCode": "T24003799",
        "errorDescription": "INVALID/ NO SIGN ON NAME SUPPLIED DURING SIGN ON PROCESS"
    }
}